$.fn.symphonyDrawer - Code Metrics - Inspection of "Set session name to prevent collisions on subdomai..." - symphonycms/symphony-2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2843)

by Brendan

created 2018-05-20 22:06 UTC

$.fn.symphonyDrawer C

↳ Parent: $.fn.symphonyDrawer

Complexity

Conditions	9
Paths	48

Size

Total Lines

Duplication

Lines	75
Ratio	98.68 %

Importance

Changes

Metric	Value
cc	9
c	0
b	0
f	0
nc	48
nop	3
dl	75
loc	76
rs	5.8219

How to fix Long Method

/**
 * @package assets
 */

(function($, Symphony) {

	/**
	 * Drawers are hidden areas in the backend that are used to
	 * display additional content on request. There are three different
	 * types of drawers: horizontal, vertical left and vertical right.
	 *
	 * @name $.symphonyDrawer
	 * @class
	 *
	 * @param {Object} options An object specifying containing the attributes specified below
	 * @param {Integer} [options.verticalWidth=300] Width of the vertical drawers
	 * @param {String} [options.speed='fast'] Animation speed
	 *
	 * @example

			$('.drawer').symphonyDrawer();
	 */
	$.fn.symphonyDrawer = function(options) {
		var objects = this,
			wrapper = $('#wrapper'),
			contents = $('#contents'),
			form = contents.find('> form'),
			settings = {
				verticalWidth: 300,
				speed: 'fast'
			};

		$.extend(settings, options);

	/*-------------------------------------------------------------------------
		Events
	-------------------------------------------------------------------------*/

		// Expand drawer
		objects.on('expand.drawer', function expand(event, speed, stay) {
			var drawer = $(this),

				position = drawer.data('position'),
				buttons = $('.button.drawer'),
				button = buttons.filter('[href="#' + drawer.attr('id') + '"]'),
				samePositionButtons = buttons.filter('.' + position),
				context = drawer.data('context') ? '.' + drawer.data('context') : '',
				height = getHeight();

			drawer.trigger('expandstart.drawer');

			speed = (typeof speed === 'undefined' ? settings.speed : speed);

			stay = (typeof stay === 'undefined' ? false : true);


			// update button state
			samePositionButtons.removeClass('selected');

			// Close opened drawers from same region
			$('.drawer.' + position).filter(function(index) {

				return $(this).data('open');
			}).trigger('collapse.drawer', [speed, true]);

			if (position === 'vertical-left') {
				drawer.css({
					width: 0,
					height: height,
					display: 'block'
				})
				.animate({
					width: settings.verticalWidth
				}, {
					duration: speed,
					step: function(now, fx){

						form.css('margin-left', now + 1); // +1px right border
					},
					complete: function() {
						form.css('margin-left', settings.verticalWidth + 1); // +1px right border
						drawer.trigger('expandstop.drawer');
					}
				});
			}
			else if (position === 'vertical-right') {
				drawer.css({
					width: 0,
					height: height,
					display: 'block'
				})
				.animate({
					width: settings.verticalWidth
				}, {
					duration: speed,
					step: function(now, fx){

						form.css('margin-right', now + 1); // +1px left border
					},
					complete: function() {
						form.css('margin-right', settings.verticalWidth + 1); // +1px right border
						drawer.trigger('expandstop.drawer');
					}
				});
			}
			else if (position === 'horizontal') {
				drawer.animate({
					height: 'show'
				}, {
					duration: speed,
					complete: function() {
						drawer.trigger('expandstop.drawer');
					}
				});
			}

			button.addClass('selected');

			// store state
			if(Symphony.Support.localStorage === true) {
				// Put in a try/catch incase we exceed storage space
				try {
					window.localStorage['symphony.drawer.' + drawer.attr('id') + context] = 'opened';
				}
				catch(e) {
					window.onerror(e.message);
				}
			}

			wrapper.addClass('drawer-' + position);
			drawer.data('open', true);
		});

		// Collapse drawer
		objects.on('collapse.drawer', function collapse(event, speed, stay) {
			var drawer = $(this),

				position = drawer.data('position'),
				buttons = $('.button.drawer'),
				button = buttons.filter('[href="#' + drawer.attr('id') + '"]'),
				context = drawer.data('context') ? '.' + drawer.data('context') : '';

			drawer.trigger('collapsestart.drawer');

			speed = (typeof speed === 'undefined' ? settings.speed : speed);

			stay = (typeof stay === 'undefined' ? false : true);


			// update button state
			button.removeClass('selected');

			if (position === 'vertical-left') {
				drawer.animate({
					width: 0
				}, {
					duration: speed,
					step: function(now, fx){

						if (!stay) {
							form.css('margin-left', now);
						}
					},
					complete: function() {
						drawer.css({
							display: 'none'
						})
						.trigger('collapsestop.drawer');
					}
				});
			}
			else if (position === 'vertical-right') {
				drawer.animate({
					width: 0
				}, {
					duration: speed,
					step: function(now, fx){

						if (!stay) {
							form.css('margin-right', now);
						}
					},
					complete: function() {
						drawer.css({
							display: 'none'
						})
						.trigger('collapsestop.drawer');
					}
				});
			}
			else if (position === 'horizontal') {
				drawer.animate({
					height: 'hide'
				}, {
					duration: speed,
					complete: function() {
						drawer.trigger('collapsestop.drawer');
					}
				});
			}

			// store state
			if(Symphony.Support.localStorage === true) {
				// Put in a try/catch incase we exceed storage space
				try {
					window.localStorage['symphony.drawer.' + drawer.attr('id') + context] = 'closed';
				}
				catch(e) {
					window.onerror(e.message);
				}
			}

			wrapper.removeClass('drawer-' + position);
			drawer.data('open', false);
		});

		// Resize drawers
		$(window).on('resize.drawer load.drawer', function() {
			var height = getHeight();
			objects.filter('.vertical-left, .vertical-right').css('height', height);
		});

	/*-------------------------------------------------------------------------
		Utilities
	-------------------------------------------------------------------------*/

		var getHeight = function() {
			var height = Math.max(window.innerHeight - contents[0].offsetTop - 1, contents[0].clientHeight);

			return height;
		};

	/*-------------------------------------------------------------------------
		Initialisation
	-------------------------------------------------------------------------*/

		objects.each(function drawers() {
			var drawer = $(this),
				position = drawer.data('position'),

				button = $('.button.drawer[href="#' + drawer.attr('id') + '"]'),
				context = drawer.data('context') ? '.' + drawer.data('context') : '',
				storedState;

			// Initial state
			if (drawer.data('default-state') === 'opened') {
				drawer.data('open', true);
			}
			// Restore state
			if (Symphony.Support.localStorage === true) {
				storedState = window.localStorage['symphony.drawer.' + drawer.attr('id') + context];
				if (storedState === 'opened') {
					drawer.data('open', true);
				}
				else if (storedState === 'closed') {
					drawer.data('open', false);
				}
			}

			// Click event for the related button
			button.on('click.drawer', function(event) {
				event.preventDefault();
				!drawer.data('open') ? drawer.trigger('expand.drawer') : drawer.trigger('collapse.drawer');
			});

			// Initially opened drawers
			drawer.data('open') ? drawer.trigger('expand.drawer', [0]) : drawer.trigger('collapse.drawer', [0, true]);
		});

	/*-----------------------------------------------------------------------*/

		return objects;
	};

})(window.jQuery, window.Symphony);


1		/**
2		* @package assets
3		*/
4
5		(function($, Symphony) {
6
7		/**
8		* Drawers are hidden areas in the backend that are used to
9		* display additional content on request. There are three different
10		* types of drawers: horizontal, vertical left and vertical right.
11		*
12		* @name $.symphonyDrawer
13		* @class
14		*
15		* @param {Object} options An object specifying containing the attributes specified below
16		* @param {Integer} [options.verticalWidth=300] Width of the vertical drawers
17		* @param {String} [options.speed='fast'] Animation speed
18		*
19		* @example
20
21		$('.drawer').symphonyDrawer();
22		*/
23		$.fn.symphonyDrawer = function(options) {
24		var objects = this,
25		wrapper = $('#wrapper'),
26		contents = $('#contents'),
27		form = contents.find('> form'),
28		settings = {
29		verticalWidth: 300,
30		speed: 'fast'
31		};
32
33		$.extend(settings, options);
34
35		/*-------------------------------------------------------------------------
36		Events
37		-------------------------------------------------------------------------*/
38
39		// Expand drawer
40		objects.on('expand.drawer', function expand(event, speed, stay) {
41	View Code Duplication	var drawer = $(this),
		0 ignored issues – show Duplication introduced 2018-05-07 21:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
42		position = drawer.data('position'),
43		buttons = $('.button.drawer'),
44		button = buttons.filter('[href="#' + drawer.attr('id') + '"]'),
45		samePositionButtons = buttons.filter('.' + position),
46		context = drawer.data('context') ? '.' + drawer.data('context') : '',
47		height = getHeight();
48
49		drawer.trigger('expandstart.drawer');
50
51		speed = (typeof speed === 'undefined' ? settings.speed : speed);
		0 ignored issues – show Comprehensibility Best Practice introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report This re-assigns to the parameter `speed`. Re-assigning to parameters often makes code less readable, consider introducing a new variable instead. Loading history...
52		stay = (typeof stay === 'undefined' ? false : true);
		0 ignored issues – show Comprehensibility Best Practice introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report This re-assigns to the parameter `stay`. Re-assigning to parameters often makes code less readable, consider introducing a new variable instead. Loading history... Unused Code introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report The assignment to variable `stay` seems to be never used. Consider removing it. Loading history...
53
54		// update button state
55		samePositionButtons.removeClass('selected');
56
57		// Close opened drawers from same region
58		$('.drawer.' + position).filter(function(index) {
		0 ignored issues – show Unused Code introduced 2018-05-07 21:13 UTC by Report Bug Copy Issue Report The parameter `index` is not used and could be removed. This check looks for parameters in functions that are not used in the function body and are not followed by other parameters which are used inside the function. Loading history...
59		return $(this).data('open');
60		}).trigger('collapse.drawer', [speed, true]);
61
62		if (position === 'vertical-left') {
63		drawer.css({
64		width: 0,
65		height: height,
66		display: 'block'
67		})
68		.animate({
69		width: settings.verticalWidth
70		}, {
71		duration: speed,
72		step: function(now, fx){
		0 ignored issues – show Unused Code introduced 2018-05-07 21:13 UTC by Report Bug Copy Issue Report The parameter `fx` is not used and could be removed. This check looks for parameters in functions that are not used in the function body and are not followed by other parameters which are used inside the function. Loading history...
73		form.css('margin-left', now + 1); // +1px right border
74		},
75		complete: function() {
76		form.css('margin-left', settings.verticalWidth + 1); // +1px right border
77		drawer.trigger('expandstop.drawer');
78		}
79		});
80		}
81		else if (position === 'vertical-right') {
82		drawer.css({
83		width: 0,
84		height: height,
85		display: 'block'
86		})
87		.animate({
88		width: settings.verticalWidth
89		}, {
90		duration: speed,
91		step: function(now, fx){
		0 ignored issues – show Unused Code introduced 2018-05-07 21:13 UTC by Report Bug Copy Issue Report The parameter `fx` is not used and could be removed. This check looks for parameters in functions that are not used in the function body and are not followed by other parameters which are used inside the function. Loading history...
92		form.css('margin-right', now + 1); // +1px left border
93		},
94		complete: function() {
95		form.css('margin-right', settings.verticalWidth + 1); // +1px right border
96		drawer.trigger('expandstop.drawer');
97		}
98		});
99		}
100		else if (position === 'horizontal') {
101		drawer.animate({
102		height: 'show'
103		}, {
104		duration: speed,
105		complete: function() {
106		drawer.trigger('expandstop.drawer');
107		}
108		});
109		}
110
111		button.addClass('selected');
112
113		// store state
114		if(Symphony.Support.localStorage === true) {
115		// Put in a try/catch incase we exceed storage space
116		try {
117		window.localStorage['symphony.drawer.' + drawer.attr('id') + context] = 'opened';
118		}
119		catch(e) {
120		window.onerror(e.message);
121		}
122		}
123
124		wrapper.addClass('drawer-' + position);
125		drawer.data('open', true);
126		});
127
128		// Collapse drawer
129		objects.on('collapse.drawer', function collapse(event, speed, stay) {
130	View Code Duplication	var drawer = $(this),
		0 ignored issues – show Duplication introduced 2018-05-07 21:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
131		position = drawer.data('position'),
132		buttons = $('.button.drawer'),
133		button = buttons.filter('[href="#' + drawer.attr('id') + '"]'),
134		context = drawer.data('context') ? '.' + drawer.data('context') : '';
135
136		drawer.trigger('collapsestart.drawer');
137
138		speed = (typeof speed === 'undefined' ? settings.speed : speed);
		0 ignored issues – show Comprehensibility Best Practice introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report This re-assigns to the parameter `speed`. Re-assigning to parameters often makes code less readable, consider introducing a new variable instead. Loading history...
139		stay = (typeof stay === 'undefined' ? false : true);
		0 ignored issues – show Comprehensibility Best Practice introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report This re-assigns to the parameter `stay`. Re-assigning to parameters often makes code less readable, consider introducing a new variable instead. Loading history...
140
141		// update button state
142		button.removeClass('selected');
143
144		if (position === 'vertical-left') {
145		drawer.animate({
146		width: 0
147		}, {
148		duration: speed,
149		step: function(now, fx){
		0 ignored issues – show Unused Code introduced 2018-05-07 21:13 UTC by Report Bug Copy Issue Report The parameter `fx` is not used and could be removed. This check looks for parameters in functions that are not used in the function body and are not followed by other parameters which are used inside the function. Loading history...
150		if (!stay) {
151		form.css('margin-left', now);
152		}
153		},
154		complete: function() {
155		drawer.css({
156		display: 'none'
157		})
158		.trigger('collapsestop.drawer');
159		}
160		});
161		}
162		else if (position === 'vertical-right') {
163		drawer.animate({
164		width: 0
165		}, {
166		duration: speed,
167		step: function(now, fx){
		0 ignored issues – show Unused Code introduced 2018-05-07 21:13 UTC by Report Bug Copy Issue Report The parameter `fx` is not used and could be removed. This check looks for parameters in functions that are not used in the function body and are not followed by other parameters which are used inside the function. Loading history...
168		if (!stay) {
169		form.css('margin-right', now);
170		}
171		},
172		complete: function() {
173		drawer.css({
174		display: 'none'
175		})
176		.trigger('collapsestop.drawer');
177		}
178		});
179		}
180		else if (position === 'horizontal') {
181		drawer.animate({
182		height: 'hide'
183		}, {
184		duration: speed,
185		complete: function() {
186		drawer.trigger('collapsestop.drawer');
187		}
188		});
189		}
190
191		// store state
192		if(Symphony.Support.localStorage === true) {
193		// Put in a try/catch incase we exceed storage space
194		try {
195		window.localStorage['symphony.drawer.' + drawer.attr('id') + context] = 'closed';
196		}
197		catch(e) {
198		window.onerror(e.message);
199		}
200		}
201
202		wrapper.removeClass('drawer-' + position);
203		drawer.data('open', false);
204		});
205
206		// Resize drawers
207		$(window).on('resize.drawer load.drawer', function() {
208		var height = getHeight();
209		objects.filter('.vertical-left, .vertical-right').css('height', height);
210		});
211
212		/*-------------------------------------------------------------------------
213		Utilities
214		-------------------------------------------------------------------------*/
215
216		var getHeight = function() {
217		var height = Math.max(window.innerHeight - contents[0].offsetTop - 1, contents[0].clientHeight);
218
219		return height;
220		};
221
222		/*-------------------------------------------------------------------------
223		Initialisation
224		-------------------------------------------------------------------------*/
225
226		objects.each(function drawers() {
227		var drawer = $(this),
228		position = drawer.data('position'),
		0 ignored issues – show Unused Code introduced 2018-05-07 21:13 UTC by Report Bug Copy Issue Report The variable `position` seems to be never used. Consider removing it. Loading history...
229		button = $('.button.drawer[href="#' + drawer.attr('id') + '"]'),
230		context = drawer.data('context') ? '.' + drawer.data('context') : '',
231		storedState;
232
233		// Initial state
234		if (drawer.data('default-state') === 'opened') {
235		drawer.data('open', true);
236		}
237		// Restore state
238		if (Symphony.Support.localStorage === true) {
239		storedState = window.localStorage['symphony.drawer.' + drawer.attr('id') + context];
240		if (storedState === 'opened') {
241		drawer.data('open', true);
242		}
243		else if (storedState === 'closed') {
244		drawer.data('open', false);
245		}
246		}
247
248		// Click event for the related button
249		button.on('click.drawer', function(event) {
250		event.preventDefault();
251		!drawer.data('open') ? drawer.trigger('expand.drawer') : drawer.trigger('collapse.drawer');
252		});
253
254		// Initially opened drawers
255		drawer.data('open') ? drawer.trigger('expand.drawer', [0]) : drawer.trigger('collapse.drawer', [0, true]);
256		});
257
258		/-----------------------------------------------------------------------/
259
260		return objects;
261		};
262
263		})(window.jQuery, window.Symphony);
264

symphonycms / symphony-2

GitHub Access Token became invalid

Pull Request — master (#2843)

$.fn.symphonyDrawer C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like